<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.hackystat.telemetry.analyzer.configuration;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.util.ArrayList;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.util.Collection;<a name="line.4"></a>
<FONT color="green">005</FONT>    import java.util.Map;<a name="line.5"></a>
<FONT color="green">006</FONT>    import java.util.TreeMap;<a name="line.6"></a>
<FONT color="green">007</FONT>    <a name="line.7"></a>
<FONT color="green">008</FONT>    import org.hackystat.sensorbase.resource.users.jaxb.User;<a name="line.8"></a>
<FONT color="green">009</FONT>    <a name="line.9"></a>
<FONT color="green">010</FONT>    /**<a name="line.10"></a>
<FONT color="green">011</FONT>     * The manager for &lt;code&gt;TelemetryDefinitionInfo&lt;/code&gt; objects. <a name="line.11"></a>
<FONT color="green">012</FONT>     * &lt;p&gt; <a name="line.12"></a>
<FONT color="green">013</FONT>     * &lt;bold&gt;Warning:&lt;/bold&gt; This class is NOT thread-safe.<a name="line.13"></a>
<FONT color="green">014</FONT>     * &lt;p&gt;<a name="line.14"></a>
<FONT color="green">015</FONT>     * V8 Notes: If/when we decide to provide project-level sharing, we need to enforce the<a name="line.15"></a>
<FONT color="green">016</FONT>     * condition that only one instance of a name can exist for a given project. Right now it<a name="line.16"></a>
<FONT color="green">017</FONT>     * appears that multiple users can create telemetry definitions with the same name with <a name="line.17"></a>
<FONT color="green">018</FONT>     * project scope.<a name="line.18"></a>
<FONT color="green">019</FONT>     * &lt;p&gt;<a name="line.19"></a>
<FONT color="green">020</FONT>     * I wonder why this class is not thread safe.  Perhaps synchronization occurs at a higher<a name="line.20"></a>
<FONT color="green">021</FONT>     * level. <a name="line.21"></a>
<FONT color="green">022</FONT>     * <a name="line.22"></a>
<FONT color="green">023</FONT>     * @author (Cedric) Qin Zhang<a name="line.23"></a>
<FONT color="green">024</FONT>     */<a name="line.24"></a>
<FONT color="green">025</FONT>    class TelemetryDefinitionInfoRepository {<a name="line.25"></a>
<FONT color="green">026</FONT>    <a name="line.26"></a>
<FONT color="green">027</FONT>      /**<a name="line.27"></a>
<FONT color="green">028</FONT>       * Two level map storing &lt;code&gt;TelemetryDefInfo&lt;/code&gt; objects. The first<a name="line.28"></a>
<FONT color="green">029</FONT>       * level is keyed by userEmail (the owner), and the second level is keyed by the<a name="line.29"></a>
<FONT color="green">030</FONT>       * name of the telemetry definition object.<a name="line.30"></a>
<FONT color="green">031</FONT>       */<a name="line.31"></a>
<FONT color="green">032</FONT>      private Map&lt;String, Map&lt;String, TelemetryDefinitionInfo&gt;&gt; ownerKeyDefMap = <a name="line.32"></a>
<FONT color="green">033</FONT>        new TreeMap&lt;String, Map&lt;String, TelemetryDefinitionInfo&gt;&gt;();<a name="line.33"></a>
<FONT color="green">034</FONT>    <a name="line.34"></a>
<FONT color="green">035</FONT>      /**<a name="line.35"></a>
<FONT color="green">036</FONT>       * Find the telemetry definition object by name. This method returns null if<a name="line.36"></a>
<FONT color="green">037</FONT>       * the telemetry definition cannot be found.<a name="line.37"></a>
<FONT color="green">038</FONT>       * &lt;p&gt;<a name="line.38"></a>
<FONT color="green">039</FONT>       * &lt;b&gt;Important&lt;/b&gt; Note that it's possible that there are multiple<a name="line.39"></a>
<FONT color="green">040</FONT>       * definitions with the same name (all have project level sharing, but owned<a name="line.40"></a>
<FONT color="green">041</FONT>       * by different users). In this case, any one of the definitions might be<a name="line.41"></a>
<FONT color="green">042</FONT>       * returned. The only guarantee is that if there are definitions in the<a name="line.42"></a>
<FONT color="green">043</FONT>       * project share scope and global share scope with the same name, the one in<a name="line.43"></a>
<FONT color="green">044</FONT>       * project share scope will be returned.<a name="line.44"></a>
<FONT color="green">045</FONT>       * <a name="line.45"></a>
<FONT color="green">046</FONT>       * @param owner The owner under which to find the telemetry definition object.<a name="line.46"></a>
<FONT color="green">047</FONT>       * @param name The name of the telemetry definition.<a name="line.47"></a>
<FONT color="green">048</FONT>       * @param includeShared If true, then those telemetry definitions owned by<a name="line.48"></a>
<FONT color="green">049</FONT>       *        other users, but is shared will also be returned.<a name="line.49"></a>
<FONT color="green">050</FONT>       * <a name="line.50"></a>
<FONT color="green">051</FONT>       * @return An instance of &lt;code&gt;TelemetryDefInfo&lt;/code&gt; object if found, or null.<a name="line.51"></a>
<FONT color="green">052</FONT>       */<a name="line.52"></a>
<FONT color="green">053</FONT>      TelemetryDefinitionInfo find(User owner, String name, boolean includeShared) {<a name="line.53"></a>
<FONT color="green">054</FONT>        TelemetryDefinitionInfo result = null;<a name="line.54"></a>
<FONT color="green">055</FONT>    <a name="line.55"></a>
<FONT color="green">056</FONT>        // find whether there is any definition owned by this user<a name="line.56"></a>
<FONT color="green">057</FONT>        Map&lt;String, TelemetryDefinitionInfo&gt; secondLevelMap = <a name="line.57"></a>
<FONT color="green">058</FONT>          this.ownerKeyDefMap.get(owner.getEmail());<a name="line.58"></a>
<FONT color="green">059</FONT>        if (secondLevelMap != null) {<a name="line.59"></a>
<FONT color="green">060</FONT>          result = secondLevelMap.get(name);<a name="line.60"></a>
<FONT color="green">061</FONT>        }<a name="line.61"></a>
<FONT color="green">062</FONT>    <a name="line.62"></a>
<FONT color="green">063</FONT>        if (result == null &amp;&amp; includeShared) {<a name="line.63"></a>
<FONT color="green">064</FONT>          // cannot find definition owned by this user, now search all definitions<a name="line.64"></a>
<FONT color="green">065</FONT>          // accessible to this user.<a name="line.65"></a>
<FONT color="green">066</FONT>          TelemetryDefinitionInfo globalDefInfo = null;<a name="line.66"></a>
<FONT color="green">067</FONT>          for (TelemetryDefinitionInfo theDefInfo : this.findAll(owner, true)) {<a name="line.67"></a>
<FONT color="green">068</FONT>            if (theDefInfo.getName().equals(name)) {<a name="line.68"></a>
<FONT color="green">069</FONT>              if (theDefInfo.getShareScope().isGlobal()) {<a name="line.69"></a>
<FONT color="green">070</FONT>                globalDefInfo = theDefInfo;<a name="line.70"></a>
<FONT color="green">071</FONT>              }<a name="line.71"></a>
<FONT color="green">072</FONT>              else {<a name="line.72"></a>
<FONT color="green">073</FONT>                result = theDefInfo;<a name="line.73"></a>
<FONT color="green">074</FONT>                break;<a name="line.74"></a>
<FONT color="green">075</FONT>              }<a name="line.75"></a>
<FONT color="green">076</FONT>            }<a name="line.76"></a>
<FONT color="green">077</FONT>          }<a name="line.77"></a>
<FONT color="green">078</FONT>          if (result == null) {<a name="line.78"></a>
<FONT color="green">079</FONT>            result = globalDefInfo;<a name="line.79"></a>
<FONT color="green">080</FONT>          }<a name="line.80"></a>
<FONT color="green">081</FONT>        }<a name="line.81"></a>
<FONT color="green">082</FONT>    <a name="line.82"></a>
<FONT color="green">083</FONT>        return result;<a name="line.83"></a>
<FONT color="green">084</FONT>      }<a name="line.84"></a>
<FONT color="green">085</FONT>    <a name="line.85"></a>
<FONT color="green">086</FONT>      /**<a name="line.86"></a>
<FONT color="green">087</FONT>       * Gets a list of telemetry definitions that this user has access to.<a name="line.87"></a>
<FONT color="green">088</FONT>       * <a name="line.88"></a>
<FONT color="green">089</FONT>       * @param owner The owner of the telemetry definitions returned.<a name="line.89"></a>
<FONT color="green">090</FONT>       * @param includesShared If true, then those telemetry definitions owned by<a name="line.90"></a>
<FONT color="green">091</FONT>       *          other users, but is shared will also be returned.<a name="line.91"></a>
<FONT color="green">092</FONT>       * <a name="line.92"></a>
<FONT color="green">093</FONT>       * @return A collection of &lt;code&gt;TelemetryDefInfo&lt;/code&gt; objects.<a name="line.93"></a>
<FONT color="green">094</FONT>       */<a name="line.94"></a>
<FONT color="green">095</FONT>      Collection&lt;TelemetryDefinitionInfo&gt; findAll(User owner, boolean includesShared) {<a name="line.95"></a>
<FONT color="green">096</FONT>        if (!includesShared) { //NOPMD<a name="line.96"></a>
<FONT color="green">097</FONT>          Map&lt;String, TelemetryDefinitionInfo&gt; secondLevelMap =  <a name="line.97"></a>
<FONT color="green">098</FONT>            this.ownerKeyDefMap.get(owner.getEmail());<a name="line.98"></a>
<FONT color="green">099</FONT>          return secondLevelMap == null ? <a name="line.99"></a>
<FONT color="green">100</FONT>              new ArrayList&lt;TelemetryDefinitionInfo&gt;(0) : secondLevelMap.values();<a name="line.100"></a>
<FONT color="green">101</FONT>        }<a name="line.101"></a>
<FONT color="green">102</FONT>        else {<a name="line.102"></a>
<FONT color="green">103</FONT>          // since shared defs need to be included, we need to scan everything.<a name="line.103"></a>
<FONT color="green">104</FONT>          ArrayList&lt;TelemetryDefinitionInfo&gt; list = new ArrayList&lt;TelemetryDefinitionInfo&gt;();<a name="line.104"></a>
<FONT color="green">105</FONT>          for (Map&lt;String, TelemetryDefinitionInfo&gt; secondLevelMap : this.ownerKeyDefMap.values()) {<a name="line.105"></a>
<FONT color="green">106</FONT>            for (TelemetryDefinitionInfo defInfo : secondLevelMap.values()) {<a name="line.106"></a>
<FONT color="green">107</FONT>              if (owner.equals(defInfo.getOwner())) {<a name="line.107"></a>
<FONT color="green">108</FONT>                list.add(defInfo);<a name="line.108"></a>
<FONT color="green">109</FONT>              }<a name="line.109"></a>
<FONT color="green">110</FONT>              else {<a name="line.110"></a>
<FONT color="green">111</FONT>                ShareScope shareScope = defInfo.getShareScope();<a name="line.111"></a>
<FONT color="green">112</FONT>                if (shareScope.isGlobal()) {<a name="line.112"></a>
<FONT color="green">113</FONT>                  list.add(defInfo);<a name="line.113"></a>
<FONT color="green">114</FONT>                }<a name="line.114"></a>
<FONT color="green">115</FONT>                else if (shareScope.isProject()) {<a name="line.115"></a>
<FONT color="green">116</FONT>                  try {<a name="line.116"></a>
<FONT color="green">117</FONT>                    if (shareScope.getProject().getMembers().getMember().contains(owner)) {<a name="line.117"></a>
<FONT color="green">118</FONT>                      list.add(defInfo);<a name="line.118"></a>
<FONT color="green">119</FONT>                    }<a name="line.119"></a>
<FONT color="green">120</FONT>                  }<a name="line.120"></a>
<FONT color="green">121</FONT>                  catch (TelemetryConfigurationException ex) {<a name="line.121"></a>
<FONT color="green">122</FONT>                    // should not happen, since we have already checked isProject()<a name="line.122"></a>
<FONT color="green">123</FONT>                    throw new RuntimeException(ex);<a name="line.123"></a>
<FONT color="green">124</FONT>                  }<a name="line.124"></a>
<FONT color="green">125</FONT>                }<a name="line.125"></a>
<FONT color="green">126</FONT>              }<a name="line.126"></a>
<FONT color="green">127</FONT>            }<a name="line.127"></a>
<FONT color="green">128</FONT>          }<a name="line.128"></a>
<FONT color="green">129</FONT>          return list;<a name="line.129"></a>
<FONT color="green">130</FONT>        }<a name="line.130"></a>
<FONT color="green">131</FONT>      }<a name="line.131"></a>
<FONT color="green">132</FONT>    <a name="line.132"></a>
<FONT color="green">133</FONT>      /**<a name="line.133"></a>
<FONT color="green">134</FONT>       * Adds a telemetry definition to this in-memory repository.<a name="line.134"></a>
<FONT color="green">135</FONT>       * <a name="line.135"></a>
<FONT color="green">136</FONT>       * @param telemetryDefInfo Information about the definition to be added.<a name="line.136"></a>
<FONT color="green">137</FONT>       * @throws TelemetryConfigurationException If there is duplicated definition.<a name="line.137"></a>
<FONT color="green">138</FONT>       */<a name="line.138"></a>
<FONT color="green">139</FONT>      void add(TelemetryDefinitionInfo telemetryDefInfo) throws TelemetryConfigurationException {<a name="line.139"></a>
<FONT color="green">140</FONT>        User owner = telemetryDefInfo.getOwner();<a name="line.140"></a>
<FONT color="green">141</FONT>        Map&lt;String, TelemetryDefinitionInfo&gt; secondLevelMap = <a name="line.141"></a>
<FONT color="green">142</FONT>          this.ownerKeyDefMap.get(owner.getEmail());<a name="line.142"></a>
<FONT color="green">143</FONT>        if (secondLevelMap == null) {<a name="line.143"></a>
<FONT color="green">144</FONT>          secondLevelMap = new TreeMap&lt;String, TelemetryDefinitionInfo&gt;();<a name="line.144"></a>
<FONT color="green">145</FONT>          this.ownerKeyDefMap.put(owner.getEmail(), secondLevelMap);<a name="line.145"></a>
<FONT color="green">146</FONT>        }<a name="line.146"></a>
<FONT color="green">147</FONT>    <a name="line.147"></a>
<FONT color="green">148</FONT>        String name = telemetryDefInfo.getName();<a name="line.148"></a>
<FONT color="green">149</FONT>        if (secondLevelMap.containsKey(name)) {<a name="line.149"></a>
<FONT color="green">150</FONT>          throw new TelemetryConfigurationException("User " + owner.toString()<a name="line.150"></a>
<FONT color="green">151</FONT>              + " already has telemetry definition " + name + " defined.");<a name="line.151"></a>
<FONT color="green">152</FONT>        }<a name="line.152"></a>
<FONT color="green">153</FONT>        secondLevelMap.put(name, telemetryDefInfo);<a name="line.153"></a>
<FONT color="green">154</FONT>      }<a name="line.154"></a>
<FONT color="green">155</FONT>    <a name="line.155"></a>
<FONT color="green">156</FONT>      /**<a name="line.156"></a>
<FONT color="green">157</FONT>       * Goes through all users, and checks whether there is a definition by name.<a name="line.157"></a>
<FONT color="green">158</FONT>       * <a name="line.158"></a>
<FONT color="green">159</FONT>       * @param telemetryDefinitionName The definition name.<a name="line.159"></a>
<FONT color="green">160</FONT>       * @return True if it exists.<a name="line.160"></a>
<FONT color="green">161</FONT>       */<a name="line.161"></a>
<FONT color="green">162</FONT>      boolean exists(String telemetryDefinitionName) {<a name="line.162"></a>
<FONT color="green">163</FONT>        boolean found = false;<a name="line.163"></a>
<FONT color="green">164</FONT>        for (Map&lt;String, TelemetryDefinitionInfo&gt; secondLevelMap : this.ownerKeyDefMap.values()) {<a name="line.164"></a>
<FONT color="green">165</FONT>          if (secondLevelMap.containsKey(telemetryDefinitionName)) {<a name="line.165"></a>
<FONT color="green">166</FONT>            found = true;<a name="line.166"></a>
<FONT color="green">167</FONT>            break;<a name="line.167"></a>
<FONT color="green">168</FONT>          }<a name="line.168"></a>
<FONT color="green">169</FONT>        }<a name="line.169"></a>
<FONT color="green">170</FONT>        return found;<a name="line.170"></a>
<FONT color="green">171</FONT>      }<a name="line.171"></a>
<FONT color="green">172</FONT>    <a name="line.172"></a>
<FONT color="green">173</FONT>      /**<a name="line.173"></a>
<FONT color="green">174</FONT>       * Deletes a telemetry object definition. Only the owner can make the<a name="line.174"></a>
<FONT color="green">175</FONT>       * deletion. This method does nothing if the definition does not exist.<a name="line.175"></a>
<FONT color="green">176</FONT>       * <a name="line.176"></a>
<FONT color="green">177</FONT>       * @param owner The owner of the definition.<a name="line.177"></a>
<FONT color="green">178</FONT>       * @param telemetryDefinitionName The name of the definition.<a name="line.178"></a>
<FONT color="green">179</FONT>       */<a name="line.179"></a>
<FONT color="green">180</FONT>      void remove(User owner, String telemetryDefinitionName) {<a name="line.180"></a>
<FONT color="green">181</FONT>        Map&lt;String, TelemetryDefinitionInfo&gt; secondLevelMap = this.ownerKeyDefMap.get(owner.getEmail());<a name="line.181"></a>
<FONT color="green">182</FONT>        if (secondLevelMap != null) {<a name="line.182"></a>
<FONT color="green">183</FONT>          secondLevelMap.remove(telemetryDefinitionName);<a name="line.183"></a>
<FONT color="green">184</FONT>        }<a name="line.184"></a>
<FONT color="green">185</FONT>      }<a name="line.185"></a>
<FONT color="green">186</FONT>    }<a name="line.186"></a>




























































</PRE>
</BODY>
</HTML>
